Contexto global

BeginPutFilesToServer

Variante de sintaxis: Por descripciones de archivos a colocar

Sintaxis:

BeginPutFilesToServer(<CallbackDescriptionOnFinish>, <CallbackDescriptionOnProgress>, <CallbackDescriptionBeforeStart>, <TransferredFileDescriptions>, <FormUniqueID>)

Parámetros:

Tipo: CallbackDescription.
Contiene la descripción de un procedimiento que se llamará si los archivos se colocan correctamente, y un procedimiento que se llamará si se produce un error.

Si al menos uno de los archivos pasados no se encuentra en el disco duro, se produce una excepción.
Después de que el archivo se coloque correctamente en el almacenamiento, se llamará al procedimiento especificado en el parámetro <CallbackDescriptionOnFinish> con los siguientes parámetros:

• <PlacedFiles> – tipo: StoredFileDescription, Undefined. Matriz de objetos del tipo StoredFileDescription, o Undefined si se cancela la colocación del archivo.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: CallbackDescription.
Contiene la descripción de un procedimiento que se llamará varias veces a medida que se colocan los archivos. El número de llamadas y el tiempo de llamada no están estrictamente definidos. con los siguientes parámetros:

• <FileToBePlaced> – tipo: FileRef Referencia al archivo colocado en el almacenamiento temporal.
• <Placed> – tipo: Number. Porcentaje de la parte colocada del archivo actual.
• <CancelPuttingFiles> – tipo: Boolean. Indica que se cancela la colocación adicional del archivo en el almacenamiento. Si establece el valor del parámetro en True en el módulo del procedimiento del controlador, se cancelará la colocación del archivo en el almacenamiento. Valor predeterminado: False. El parámetro devuelto.
• <TotalPlaced> – tipo: Number. Porcentaje de la parte colocada de todos los archivos.
• <CancelPuttingAllFiles> – tipo: Boolean. Indica que se cancela la colocación de todos los archivos. Si establece el valor del parámetro en True en el módulo del procedimiento del controlador, se cancelará la colocación de todos los archivos en el almacenamiento. Valor predeterminado: False. El parámetro devuelto.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: CallbackDescription.
Contiene la descripción del procedimiento que se llamará antes de que se almacenen los archivos. La notificación se llama con los siguientes parámetros:

• <FilesToStore> – tipo: FileRef Matriz de elementos del tipo FileRef que están listos para ser colocados en un almacenamiento temporal.
• <CancelPuttingAllFiles> – tipo: Boolean. Indica que se cancela la colocación de todos los archivos. Si establece este parámetro en True en el modo del procedimiento del controlador, se cancelará la colocación de todos los archivos (en este caso, no se llamará ninguna otra notificación). Valor predeterminado: False. El parámetro devuelto.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: Array.
Una matriz de objetos TransferableFileDescription. Cada elemento de la matriz debe contener una ruta no vacía al archivo en el disco duro. La dirección del almacenamiento temporal en el que se colocará un archivo puede dejarse en blanco. En este caso, se crea un nuevo archivo.

Tipo: UUID.
El UUID del formulario que se puede obtener con la propiedad UUID de un formulario de aplicación cliente.
El archivo se guarda en un almacenamiento temporal y se elimina después de que se elimina el objeto de formulario.
Si omite este parámetro, el valor almacenado se borra después de la siguiente llamada al servidor desde un módulo común, o en una llamada al servidor de contexto o sin contexto desde un formulario, o en una llamada al servidor desde un módulo de comando, o al obtener un formulario.

Descripción de la variante del método:

Inicia la colocación de archivos establecidos por rutas en el disco duro desde el sistema de archivos local en el almacenamiento temporal.
La extensión de operación de archivo es requerida en el cliente web.
El controlador <NotificationOfExecutionProgressDescription> se llamará en el cliente web solo dos veces: cuando la cantidad total de bytes colocados en el almacenamiento temporal sea igual a 0 o al tamaño completo de los archivos colocados.

Variante de sintaxis: Por una cadena de búsqueda

Sintaxis:

BeginPutFilesToServer(<CallbackDescriptionOnFinish>, <CallbackDescriptionOnProgress>, <CallbackDescriptionBeforeStart>, <SearchString>, <FormUniqueID>)

Parámetros:

Tipo: CallbackDescription.
Contiene la descripción de un procedimiento que se llamará si los archivos se colocan correctamente, y un procedimiento que se llamará si se produce un error.

Si al menos uno de los archivos pasados no se encuentra en el disco duro, se produce una excepción.
Después de que el archivo se coloque correctamente en el almacenamiento, se llamará al procedimiento especificado en el parámetro <CallbackDescriptionOnFinish> con los siguientes parámetros:

• <PlacedFiles> – tipo: StoredFileDescription, Undefined. Matriz de objetos del tipo StoredFileDescription, o Undefined si se cancela la colocación del archivo.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: CallbackDescription.
Contiene la descripción de un procedimiento que se llamará varias veces a medida que se colocan los archivos. El número de llamadas y el tiempo de llamada no están estrictamente definidos. con los siguientes parámetros:

• <FileToBePlaced> – tipo: FileRef Referencia al archivo colocado en el almacenamiento temporal.
• <Placed> – tipo: Number. Porcentaje de la parte colocada del archivo actual.
• <CancelPuttingFiles> – tipo: Boolean. Indica que se cancela la colocación adicional del archivo en el almacenamiento. Si establece el valor del parámetro en True en el módulo del procedimiento del controlador, se cancelará la colocación del archivo en el almacenamiento. Valor predeterminado: False. El parámetro devuelto.
• <TotalPlaced> – tipo: Number. Porcentaje de la parte colocada de todos los archivos.
• <CancelPuttingAllFiles> – tipo: Boolean. Indica que se cancela la colocación de todos los archivos. Si establece el valor del parámetro en True en el módulo del procedimiento del controlador, se cancelará la colocación de todos los archivos en el almacenamiento. Valor predeterminado: False. El parámetro devuelto.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: CallbackDescription.
Contiene la descripción del procedimiento que se llamará antes de que se almacenen los archivos. La notificación se llama con los siguientes parámetros:

• <FilesToStore> – tipo: FileRef Matriz de elementos del tipo FileRef que están listos para ser colocados en un almacenamiento temporal.
• <CancelPuttingAllFiles> – tipo: Boolean. Indica que se cancela la colocación de todos los archivos. Si establece este parámetro en True en el modo del procedimiento del controlador, se cancelará la colocación de todos los archivos (en este caso, no se llamará ninguna otra notificación). Valor predeterminado: False. El parámetro devuelto.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: String.
La cadena debe ser una ruta al directorio donde se realiza la búsqueda. El directorio puede estar ubicado tanto en LAN como en un servidor FTP. Al utilizar este esquema, se deben especificar barras diagonales ‘/’ y no barras invertidas ‘\’ .
Se permite especificar el nombre completo del archivo (ruta + nombre).

Tipo: UUID.
El UUID del formulario que se puede obtener con la propiedad UUID de un formulario de aplicación cliente.
El archivo se coloca en un almacenamiento temporal y se elimina automáticamente después de que se elimina el objeto de formulario de la aplicación cliente.
Si omite este parámetro, el valor almacenado se borra después de la siguiente llamada al servidor desde un módulo común, o en una llamada al servidor de contexto o sin contexto desde un formulario, o en una llamada al servidor desde un módulo de comando, o al obtener un formulario.

Descripción de la variante del método:

Inicia la colocación de archivos encontrados por la cadena de búsqueda desde el sistema de archivos local en el almacenamiento temporal.
La extensión de operación de archivo es requerida en el cliente web.
El controlador <NotificationOfExecutionProgressDescription> se llama en el cliente web solo dos veces: cuando la cantidad total de bytes colocados en el almacenamiento temporal es igual a 0 o al tamaño completo de los archivos colocados.

Variante de sintaxis: Por enlaces a archivos

Sintaxis:

BeginPutFilesToServer(<CallbackDescriptionOnFinish>, <CallbackDescriptionOnProgress>, <CallbackDescriptionBeforeStart>, <FileRefs>, <FormUniqueID>)

Parámetros:

Tipo: CallbackDescription.
Contiene la descripción de un procedimiento que se llamará si los archivos se colocan correctamente, y un procedimiento que se llamará si se produce un error.

Si al menos uno de los archivos pasados no se encuentra en el disco duro, se produce una excepción.
Después de que el archivo se coloque correctamente en el almacenamiento, se llamará al procedimiento especificado en el parámetro <CallbackDescriptionOnFinish> con los siguientes parámetros:

• <PlacedFiles> – tipo: StoredFileDescription, Undefined. Matriz de objetos del tipo StoredFileDescription, o Undefined si se cancela la colocación del archivo.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: CallbackDescription.
Contiene la descripción de un procedimiento que se llamará varias veces a medida que se colocan los archivos. El número de llamadas y el tiempo de llamada no están estrictamente definidos. con los siguientes parámetros:

• <FileToBePlaced> – tipo: FileRef Referencia al archivo colocado en el almacenamiento temporal.
• <Placed> – tipo: Number. Porcentaje de la parte colocada del archivo actual.
• <CancelPuttingFiles> – tipo: Boolean. Indica que se cancela la colocación adicional del archivo en el almacenamiento. Si establece el valor del parámetro en True en el módulo del procedimiento del controlador, se cancelará la colocación del archivo en el almacenamiento. Valor predeterminado: False. El parámetro devuelto.
• <TotalPlaced> – tipo: Number. Porcentaje de la parte colocada de todos los archivos.
• <CancelPuttingAllFiles> – tipo: Boolean. Indica que se cancela la colocación de todos los archivos. Si establece el valor del parámetro en True en el módulo del procedimiento del controlador, se cancelará la colocación de todos los archivos en el almacenamiento. Valor predeterminado: False. El parámetro devuelto.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: CallbackDescription.
Contiene la descripción del procedimiento que se llamará antes de que se almacenen los archivos. La notificación se llama con los siguientes parámetros:

• <FilesToStore> – tipo: FileRef Matriz de elementos del tipo FileRef que están listos para ser colocados en un almacenamiento temporal.
• <CancelPuttingAllFiles> – tipo: Boolean. Indica que se cancela la colocación de todos los archivos. Si establece este parámetro en True en el modo del procedimiento del controlador, se cancelará la colocación de todos los archivos (en este caso, no se llamará ninguna otra notificación). Valor predeterminado: False. El parámetro devuelto.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: Array.
Contiene una matriz de objetos del tipo FileRef.

Tipo: UUID.
El UUID del formulario que se puede obtener con la propiedad UUID de un formulario de aplicación cliente.
El archivo se guarda en un almacenamiento temporal y se elimina después de que se elimina el objeto de formulario.
Si omite este parámetro, el valor almacenado se borra después de la siguiente llamada al servidor desde un módulo común, o en una llamada al servidor de contexto o sin contexto desde un formulario, o en una llamada al servidor desde un módulo de comando, o al obtener un formulario.

Descripción de la variante del método:

Inicia la colocación de archivos establecidos por referencias a archivos desde el sistema de archivos local en el almacenamiento temporal.
La extensión de operación de archivo no es requerida en el cliente web.

Variante de sintaxis: Usando el cuadro de diálogo de selección de archivos

Sintaxis:

BeginPutFilesToServer(<CallbackDescriptionOnFinish>, <CallbackDescriptionOnProgress>, <CallbackDescriptionBeforeStart>, <DialogParameters>, <FormUniqueID>)

Parámetros:

Tipo: CallbackDescription.
Establece un procedimiento para llamar si los archivos se colocan correctamente, y un procedimiento que se llamará si se produce un error.

Después de que el archivo se coloque correctamente en el almacenamiento, se llamará al procedimiento especificado en el parámetro <CallbackDescriptionOnFinish> con los siguientes parámetros:

• <PlacedFiles> – tipo: StoredFileDescription, Undefined. Matriz de objetos del tipo StoredFileDescription, o Undefined si se cancela la colocación del archivo.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: CallbackDescription.
Contiene la descripción de un procedimiento que se llamará varias veces a medida que se colocan los archivos. El número de llamadas y el tiempo de llamada no están estrictamente definidos. con los siguientes parámetros:

• <FileToBePlaced> – tipo: FileRef Referencia al archivo colocado en el almacenamiento temporal.
• <Placed> – tipo: Number. Porcentaje de la parte colocada del archivo actual.
• <CancelPuttingFiles> – tipo: Boolean. Indica que se cancela la colocación adicional del archivo en el almacenamiento. Si establece el valor del parámetro en True en el módulo del procedimiento del controlador, se cancelará la colocación del archivo en el almacenamiento. Valor predeterminado: False. El parámetro devuelto.
• <TotalPlaced> – tipo: Number. Porcentaje de la parte colocada de todos los archivos.
• <CancelPuttingAllFiles> – tipo: Boolean. Indica que se cancela la colocación de todos los archivos. Si establece el valor del parámetro en True en el módulo del procedimiento del controlador, se cancelará la colocación de todos los archivos en el almacenamiento. Valor predeterminado: False. El parámetro devuelto.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: CallbackDescription.
Contiene la descripción del procedimiento que se llamará antes de que se almacenen los archivos. La notificación se llama con los siguientes parámetros:

• <FilesToStore> – tipo: Array Matriz de elementos del tipo FileRef que están listos para ser colocados en un almacenamiento temporal.
• <CancelPuttingAllFiles> – tipo: Boolean. Indica que se cancela la colocación de todos los archivos. Si establece este parámetro en True en el modo del procedimiento del controlador, se cancelará la colocación de todos los archivos (en este caso, no se llamará ninguna otra notificación). Valor predeterminado: False. El parámetro devuelto.
• <AdditionalParameters> – el valor especificado al crear el objeto CallbackDescription.

Tipo: PutFilesDialogParameters.
La estructura que contiene los parámetros del cuadro de diálogo que se mostrará al usuario.

Tipo: UUID.
El UUID del formulario que se puede obtener con la propiedad UUID de un formulario de aplicación cliente.
El archivo se guarda en un almacenamiento temporal y se elimina después de que se elimina el objeto de formulario.
Si omite este parámetro, el valor almacenado se borra después de la siguiente llamada al servidor desde un módulo común, o en una llamada al servidor de contexto o sin contexto desde un formulario, o en una llamada al servidor desde un módulo de comando, o al obtener un formulario.

Descripción de la variante del método:

Inicia la colocación de archivos y muestra el cuadro de diálogo de selección de archivos para seleccionar los archivos que se colocarán desde el sistema de archivos local en el almacenamiento temporal.
La extensión de operación de archivo no es requerida en el cliente web.

Descripción:

Comienza a colocar archivos en el almacenamiento temporal.

Disponibilidad:

Cliente ligero, cliente web, cliente móvil, cliente grueso, aplicación móvil (cliente), aplicación móvil (servidor), servidor independiente móvil.

Nota:

En el cliente web, si se llama al método a través de la extensión del sistema de archivos, el controlador <NotificationOfProgressDescription> se llama solo dos veces: cuando la cantidad total de bytes colocados en el almacenamiento temporal es igual a 0 o cuando es igual al tamaño completo de los archivos colocados.
Después de llamar a este método, puede llamar a un método similar sin esperar a que se complete el anterior.

Disponible desde:

Disponible desde la versión 8.3.15.

---